home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1999 August / SGI Freeware 1999 August.iso / dist / fw_emacs.idb / usr / freeware / catman / u_man / cat1 / emacstool.Z / emacstool
Encoding:
Text File  |  1998-10-28  |  6.8 KB  |  199 lines
  1.  
  2.  
  3.  
  4.      EEEEMMMMAAAACCCCSSSSTTTTOOOOOOOOLLLL((((1111))))           UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV          EEEEMMMMAAAACCCCSSSSTTTTOOOOOOOOLLLL((((1111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.       _e_m_a_c_s_t_o_o_l - run emacs    under Sun windows with function-key
  10.       and mouse support.
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.       _e_m_a_c_s_t_o_o_l [{window_args} {-rc    run_command_path} args ... ]
  14.  
  15.      TTTTYYYYPPPPIIIICCCCAAAALLLL UUUUSSSSAAAAGGGGEEEE
  16.       In ~/.suntools or ~/.rootmenu    include    a line like this:
  17.       "Emacstool"      emacstool -WI    emacs.icon -f emacstool-init
  18.  
  19.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  20.       EEEEmmmmaaaaccccssssttttoooooooollll creates a SunView frame and    a tty subwindow    within
  21.       which    mouse events and function keys are translated to ASCII
  22.       sequences which Emacs    can parse.  The    translated input
  23.       events are sent to the process running in the    tty subwindow,
  24.       which    is typically GNU Emacs.     Emacstool thereby allows GNU
  25.       Emacs    users to make full use of the mouse and    function keys.
  26.       GNU Emacs can    be loaded with functions to interpret the
  27.       mouse    and function-key events    to make    a truly    fine screen
  28.       oriented editor for the Sun Workstation.
  29.  
  30.       (Note    that GNU Emacs has a special interface to the X    window
  31.       system as well.  The X window    system has many    technical
  32.       advantages, it is an industry    standard, and it is also free
  33.       software.  The Free Software Foundation urges    you to try X
  34.       windows, and distributes a free copy of X on Emacs
  35.       distribution tapes.)
  36.  
  37.       Function keys    are translated to a sequence of    the form
  38.       `^X*[a-o][lrt]'.  The    last character is `l', `r', or `t'
  39.       corresponding    to whether the key is among the    Left, Right,
  40.       or Top function keys.     The third character indicates which
  41.       button of the    group was pressed.  Thus, the function key in
  42.       the lower right corner will transmit the sequence `^X*or'.
  43.       In addition, the [lrt] is affected by    the Control, Meta, and
  44.       Shift    keys.  Unshifted Control keys will be non-alphabetic:
  45.       C-l is [,], C-r is [2], C-t is [4].
  46.  
  47.       Mouse    buttons    are encoded as `^X^@([124] x y)\n'.  ^X^@ is
  48.       the standard GNU Emacs mouse event prefix, it    is followed by
  49.       a list indicating the    button pressed and the character row
  50.       and column of    the point in the window    where the mouse    cursor
  51.       is, and followed by a    newline    character.  In GNU Emacs, the
  52.       ^X^@ dispatches to a mouse event handler which then reads
  53.       the following    list.
  54.  
  55.      OOOOPPPPTTTTIIIIOOOONNNNSSSS
  56.       EEEEmmmmaaaaccccssssttttoooooooollll supports all the standard window arguments,
  57.       including font and icon specifiers.
  58.  
  59.       By default, Emacstool    runs the program _e_m_a_c_s in the created
  60.  
  61.  
  62.  
  63.      Page 1                         (printed 7/23/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      EEEEMMMMAAAACCCCSSSSTTTTOOOOOOOOLLLL((((1111))))           UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV          EEEEMMMMAAAACCCCSSSSTTTTOOOOOOOOLLLL((((1111))))
  71.  
  72.  
  73.  
  74.       subwindow. The value of the environment variable _E_M_A_C_S_T_O_O_L
  75.       can be used to override this if your version of EEEEmmmmaaaaccccssss    is not
  76.       accessible on    your search path by the    name _E_m_a_c_s. In
  77.       addition, the    run command can    be set by the _p_a_t_h_n_a_m_e
  78.       following the    last occurrence    of the -_r_c flag.  This is
  79.       convenient for using Emacstool to run    on remote machines.
  80.  
  81.       All other command line arguments not used by the window
  82.       system are passed as arguments to the    program    that runs in
  83.       the Emacstool    window.
  84.  
  85.       For example:
  86.  
  87.       local% (emacstool -rc    rlogin remote -8 &)&
  88.  
  89.       will create an Emacstool window logged in to a machine named
  90.       _r_e_m_o_t_e. If Emacs is run from this window, Emacstool will
  91.       encode mouse and function keys, and send them    to rlogin.  If
  92.       Emacs    is run from this shell on the remote machine, it will
  93.       see the mouse    and function keys properly.  However, since
  94.       the remote host does not have    access to the screen, the
  95.       cursor cannot    be changed, menus will not appear, and the
  96.       selection buffer (STUFF) is limited.
  97.  
  98.      UUUUssssiiiinnnngggg WWWWiiiitttthhhh    GGGGNNNNUUUU EEEEmmmmaaaaccccssss::::
  99.       The GNU Emacs    files lisp/term/sun.el,    lisp/sun-mouse.el,
  100.       lisp/sun-fns.el, and src/sunfns.c provide emacs support for
  101.       the Emacstool    and function keys.  Emacstool will
  102.       automatically    set the    TERM environment variable to be    "sun"
  103.       and unset the    environment variable TERMCAP.  That is,    these
  104.       variables will not be    inherited from the shell that starts
  105.       Emacstool.  Since the    terminal type is _S_U_N (that is, the
  106.       environment variable TERM is set to _S_U_N), Emacs will
  107.       automatically    load the file lisp/term/sun.  This, in turn,
  108.       will ensure that sun-mouse.el    is autoloaded when any mouse
  109.       events are detected.    It is suggested    that _s_u_n-_m_o_u_s_e and
  110.       _s_u_n-_f_n_s be loaded in your site-init.el file, so that they
  111.       will always be loaded    when running on    a Sun workstation.
  112.  
  113.       In addition, Emacstool sets the environment variable
  114.       IN_EMACSTOOL = "t".  Lisp code in your ~/.emacs can use
  115.       (getenv "IN_EMACSTOOL") to determine whether to do Emacstool
  116.       specific initialization.  Sun.el uses    this to    automatically
  117.       call emacstool-init (getenv "IN_EMACSTOOL") is defined.
  118.  
  119.       The file src/sunfns.c    defines    several    useful functions for
  120.       emacs    on the Sun.  Among these are procedures    to pop-up
  121.       SunView _m_e_n_u_s, put and get from the SunView _S_T_U_F_F buffer,
  122.       and a    procedure for changing the cursor _i_c_o_n.    If you want to
  123.       define or edit cursor    icons, there is    a rudimentary mouse
  124.       driven icon editor in    the file lisp/sun-cursors.el.  Try
  125.       invoking (sc:edit-cursor)
  126.  
  127.  
  128.  
  129.      Page 2                         (printed 7/23/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      EEEEMMMMAAAACCCCSSSSTTTTOOOOOOOOLLLL((((1111))))           UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV          EEEEMMMMAAAACCCCSSSSTTTTOOOOOOOOLLLL((((1111))))
  137.  
  138.  
  139.  
  140.      BBBBUUUUGGGGSSSS
  141.       It takes a few milliseconds to create    a menu before it pops
  142.       up.
  143.  
  144.      EEEENNNNVVVVIIIIRRRROOOONNNNMMMMEEEENNNNTTTT VVVVAAAARRRRIIIIAAAABBBBLLLLEEEESSSS
  145.       EMACSTOOL IN_EMACSTOOL TERM TERMCAP
  146.  
  147.      FFFFIIIILLLLEEEESSSS
  148.       emacs
  149.  
  150.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  151.       emacs(1)
  152.        .../etc/SUN-SUPPORT
  153.        .../lisp/term/sun.el
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                         (printed 7/23/98)
  196.  
  197.  
  198.  
  199.